<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class uhu_LLSD_binary</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class uhu_LLSD_binary</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The class used to represent binary LLSD nodes- allows a native PHP data type to hold binary elements in order to differentiate them from normal strings</p>
		<p class="notes">
			Located in <a class="field" href="_apps---secondlife---LLSD---binary.php.html">/apps/secondlife/LLSD/binary.php</a> (line <span class="field">11</span>)
		</p>
		
				
		<pre><a href="../LLSD/uhu_LLSD_common.html">uhu_LLSD_common</a>
   |
   --uhu_LLSD_binary</pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																												<div class="var-title">
					static <span class="var-type">bool</span>
					<a href="#$fail_on_unsupported_encoding" title="details" class="var-name">$fail_on_unsupported_encoding</a>
				</div>
																				<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$data" title="details" class="var-name">$data</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$encoding" title="details" class="var-name">$encoding</a>
				</div>
																			</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																				<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#decode" title="details" class="method-name">decode</a>
											(<span class="var-type"><a href="../LLSD/uhu_LLSD_binary.html">uhu_LLSD_binary</a></span>&nbsp;<span class="var-name">$data</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#encode" title="details" class="method-name">encode</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>)
									</div>
																								<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#fail_on_unsupported_encoding" title="details" class="method-name">fail_on_unsupported_encoding</a>
											([<span class="var-type">bool</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">true</span>])
									</div>
																
												<div class="method-definition">
											<span class="method-result">uhu_LLSD_binary</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
									</div>
																																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#encoding" title="details" class="method-name">encoding</a>
										()
									</div>
																								<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#__toString" title="details" class="method-name">__toString</a>
										()
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$fail_on_unsupported_encoding" id="$fail_on_unsupported_encoding"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">bool</span>
			<span class="var-name">$fail_on_unsupported_encoding</span>
			 = <span class="var-default"> true</span>			(line <span class="line-number">24</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> Whether to throw an exception if an unsupported encoding is found.</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$data" id="$data"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$data</span>
						(line <span class="line-number">16</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> The contents of the binary element.</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../LLSD/uhu_LLSD_binary.html#method__toString">uhu_LLSD_binary::__toString()</a></li>
				<li><span class="field">usedby:</span> <a href="../LLSD/uhu_LLSD_binary.html#method__construct">uhu_LLSD_binary::__construct()</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$encoding" id="$encoding"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$encoding</span>
						(line <span class="line-number">20</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> The encoding type specified in the binary node</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../LLSD/uhu_LLSD_binary.html#methodencoding">uhu_LLSD_binary::encoding()</a></li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methoddecode" id="decode"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method decode</span> (line <span class="line-number">80</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Decodes the binary data.</p>
	<ul class="tags">
				<li><span class="field">return:</span> the decoded data.</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> <a href="../UHU_exception/LLSD/uhu_LLSD_exception.html">uhu_LLSD_exception</a></li>
				<li><span class="field">uses:</span> <a href="../LLSD/uhu_LLSD_binary.html#methodencoding">uhu_LLSD_binary::encoding()</a></li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">string</span>
		<span class="method-name">
			decode
		</span>
					(<span class="var-type"><a href="../LLSD/uhu_LLSD_binary.html">uhu_LLSD_binary</a></span>&nbsp;<span class="var-name">$data</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../LLSD/uhu_LLSD_binary.html">uhu_LLSD_binary</a></span>
				<span class="var-name">$data</span>			</li>
				</ul>
		
			
	</div>
<a name="methodencode" id="encode"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method encode</span> (line <span class="line-number">70</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Rather pointless, given that only base64 is supported currently.</p>
	<ul class="tags">
				<li><span class="field">return:</span> base64-encoded version of the data supplied.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">string</span>
		<span class="method-name">
			encode
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$data</span><span class="var-description">: The data to be encoded.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodfail_on_unsupported_encoding" id="fail_on_unsupported_encoding"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method fail_on_unsupported_encoding</span> (line <span class="line-number">45</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Use to toggle whether exceptions should be thrown if an unsupported encoding is found.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			fail_on_unsupported_encoding
		</span>
					([<span class="var-type">bool</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">true</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$flag</span><span class="var-description">: Set to false if binary elements aren't going to be decoded.</span>			</li>
				</ul>
		
			
	</div>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">31</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Builds an instance of uhu_LLSD_binary.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> <a href="../LLSD/uhu_LLSD_binary.html#var$data">uhu_LLSD_binary::$data</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">uhu_LLSD_binary</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">SimpleXMLElement</span>
				<span class="var-name">$data</span><span class="var-description">: The binary node</span>			</li>
				</ul>
		
			
	</div>
<a name="methodencoding" id="encoding"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">encoding</span> (line <span class="line-number">53</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">return:</span> The encoding of the binary element.</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="../LLSD/uhu_LLSD_binary.html#methoddecode">uhu_LLSD_binary::decode()</a></li>
				<li><span class="field">uses:</span> <a href="../LLSD/uhu_LLSD_binary.html#var$encoding">uhu_LLSD_binary::$encoding</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			encoding
		</span>
				()
			</div>
	
		
			
	</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">__toString</span> (line <span class="line-number">61</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">return:</span> The binary data</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> <a href="../LLSD/uhu_LLSD_binary.html#var$data">uhu_LLSD_binary::$data</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			__toString
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Tue, 13 Jan 2009 23:21:43 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>